ses-ux

1.0.x
(0 reviews)

POST-TMF679 checkSubsTransEligibility

POST-TMF679 checkSubsTransEligibility

checkSubsTransEligibility

This method is to check if the subscription can be transferred to another eSIM capable device

URL
https://{host:port}/{context}/esintegration/v1.0/esim/checkSubsTransEligibility
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.Y
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/ses-ux/post/esintegration/v1.0/esim/checkSubsTransEligibility' \
--header 'Authorization: Basic MmZkNjE1OTlhN2U3NDFlYjk3ZDQxZDRlM2QzOWUwMGY6YTI3ZTk1NzcwNzBkNDI2MjkxNmQ4ZTc3NDI2ZTNGODE=' \
--header 'X-Correlation-ID: 5478-asdf5454-sad545-sear545dsf-54e5d4g' \
--header 'Content-Type: application/json' \
--data '{
    "primaryMsisdn": "8613922114718",
    "eid": "8986010110231170985S",
    "imei": "353774071869631,353774071860799",
    "imsi": "460019876543218",
    "iccid": "89014104277527978258",
    "isPhysicalSim": true,
    "deviceVendor": "Apple",
    "deviceType": "iPhone",
    "osType": "iOS",
    "osVersion": "15.0",
    "clientType": 0,
    "carrierBundleVersion": "21.0",
    "operatorId": "1000",
    "uiccSignatureStatus": 0
}'
Definitions

Each of the request parameters is detailed.

nametypedescriptionrequired
primaryMsisdnstringThe phone number associated to the subscription. For the subscription with standalone phone number, it is the MSISDN of the subscriptionY
eidstringThe unique identity of the eUICC if the subscription is activated on an eSIMN*
imeistringThe IMEI of the device that the subscription is activated on.N*
imsistringThe IMSI of the subscription to be transferred.N*
iccidstringThe ICCID of the SIM or eSIM profile that the IMSI links to.N
isPhysicalSimbooleanWhether the IMSI of the subscription belongs to a physical SIM card or eSIM profile.N
deviceVendorstringThe vendor of the eSIM device that initializes the transfer operationN
osTypestringThe specific OS type of the eSIM device, for example: iOS, Android, and Windows.N
osVersionstringThe specific OS version of the eSIM deviceN
clientTypeIntegerThe client type of the companion App that triggers the transfer operation.  0: iOS devices.  1: clients compliant to Ericsson Proprietary API  3: Window devices  4: GSMA TS.43- compliant devicesN
carrierBundleVersionstringThe specific bundle version of the carrier.N
operatorIdstringThe identity of the operator of the subscriber’s phone number.N
uiccSignatureStatusIntegerThe status of the UICC signature validation, the purpose of this validation is to prove that the SIM card to be transferred is bound to the old primary device. Possible values:N
Success Response1
{
"subTransferBlocked": 0
}
Success Response2
{
"subTransferBlocked": 1,
"blockedReason": "A MACD (Move, Add, Change, Disconnect) order is already in progress for this subscription. Please wait until the current order is completed before initiating a new SIM transfer."
}
Definitions

Each of the request parameters is detailed.

nametypedescriptionrequired
subTransferBlockedIntegerWhether the subscriber can perform the subscription transfer operation.  0: Not blocked  1: BlockedY
blockedReasonstringThe reason why the subscription transfer is blocked. This parameter must be returned when parameter subTransferBlocke d is set to 1.N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
 "error": "The request is invalid or not properly formed.",
 "error_description": "Malformed request syntax, invalid request message framing, or deceptive request routing."
}
[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
 "error": "Subscriber Not Found",
 "error_description": "The requested operation failed because a resource associated with the request could not be found."
}
[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
 "error": "Internal Server Error",
 "error_description": "The request failed due to an internal error"
}

Reviews